// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
// Copyright (c) 2011, Dr. Masroor Ehsan
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the author nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// $Author:$
// $Id:$
// $Rev:$
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

using System;

namespace MaxTrader.BusinessObjects
{
    public class CashTransaction : AbstractTransaction, IComparable<CashTransaction>, ICloneable,
                                   IEquatable<CashTransaction>
    {
        public CashTransaction()
        {
            Type = TransactionType.CashTransaction;
        }

        /// <summary>
        ///   The associated cash account if any
        /// </summary>
        public virtual CashAccount CashAccount { get; set; }

        /// <summary>
        ///   The second associated cash account if any
        /// </summary>
        public virtual CashAccount CashAccount2 { get; set; }

        #region ICloneable Members

        public virtual object Clone()
        {
            return new CashTransaction
                       {
                           Portfolio = Portfolio,
                           Category = Category,
                           Date = Date,
                           Amount = Amount,
                           CashAccount = CashAccount,
                           CashAccount2 = CashAccount2,
                       };
        }

        #endregion

        #region IComparable<CashTransaction> Members

        /// <summary>
        ///   Transactions are compared by date only.
        /// </summary>
        public virtual int CompareTo(CashTransaction other)
        {
            return other.Date.CompareTo(Date);
        }

        #endregion

        #region IEquatable<CashTransaction> Members

        public virtual bool Equals(CashTransaction other)
        {
            // Test the fields that are always present
            if (!other.Date.Equals(Date)
                || other.Category != Category
                || !other.Amount.Equals(Amount)
                )
                return false;

            // The following fields might be null, so check they are either both null or not
            if (
                ((other.CashAccount == null) != (CashAccount == null)) ||
                ((other.CashAccount2 == null) != (CashAccount2 == null))
                )
                return false;

            // Now check if the fields contain the same value
            if ((other.CashAccount != null) && !other.CashAccount.Equals(CashAccount)) return false;
            if ((other.CashAccount2 != null) && !other.CashAccount2.Equals(CashAccount2)) return false;

            // If we got here they are the same
            return true;
        }

        #endregion
    }
}